<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>websocket::stream::handshake (1 of 4 overloads)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../handshake.html" title="websocket::stream::handshake">
<link rel="prev" href="../handshake.html" title="websocket::stream::handshake">
<link rel="next" href="overload2.html" title="websocket::stream::handshake (2 of 4 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../handshake.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="beast.ref.boost__beast__websocket__stream.handshake.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::handshake (1 of 4 overloads)">websocket::stream::handshake
          (1 of 4 overloads)</a>
</h6></div></div></div>
<p>
            Perform the WebSocket handshake in the client role.
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.h0"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake.overload1.synopsis">Synopsis</a>
          </h7><pre class="programlisting"><span class="keyword">void</span>
<span class="identifier">handshake</span><span class="special">(</span>
    <span class="identifier">string_view</span> <span class="identifier">host</span><span class="special">,</span>
    <span class="identifier">string_view</span> <span class="identifier">target</span><span class="special">);</span>
</pre>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.h1"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake.overload1.description">Description</a>
          </h7><p>
            This function is used to perform the <a href="https://en.wikipedia.org/wiki/WebSocket#Protocol_handshake" target="_top">WebSocket
            handshake</a>, required before messages can be sent and received.
            During the handshake, the client sends the Websocket Upgrade HTTP request,
            and the server replies with an HTTP response indicating the result of
            the handshake. The call blocks until one of the following conditions
            is true:
          </p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
                The request is sent and the response is received.
              </li>
<li class="listitem">
                An error occurs.
              </li>
</ul></div>
<p>
            The algorithm, known as a <span class="emphasis"><em>composed operation</em></span>, is
            implemented in terms of calls to the next layer's <code class="computeroutput"><span class="identifier">read_some</span></code>
            and <code class="computeroutput"><span class="identifier">write_some</span></code> functions.
            The handshake is successful if the received HTTP response indicates the
            upgrade was accepted by the server, represented by a <a href="https://tools.ietf.org/html/rfc7230#section-3.1.2" target="_top">status-code</a>
            of <a class="link" href="../../boost__beast__http__status.html" title="http::status"><code class="computeroutput"><span class="identifier">beast</span><span class="special">::</span><span class="identifier">http</span><span class="special">::</span><span class="identifier">status</span><span class="special">::</span><span class="identifier">switching_protocols</span></code></a>.
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.h2"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake.overload1.parameters">Parameters</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">host</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The name of the remote host. This is required by the HTTP protocol
                      to set the "Host" header field.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">target</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The request-target, in origin-form. The server may use the
                      target to distinguish different services on the same listening
                      port.
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.h3"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.exceptions"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake.overload1.exceptions">Exceptions</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Type
                    </p>
                  </th>
<th>
                    <p>
                      Thrown On
                    </p>
                  </th>
</tr></thead>
<tbody><tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">system_error</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      Thrown on failure.
                    </p>
                  </td>
</tr></tbody>
</table></div>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.h4"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.example"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake.overload1.example">Example</a>
          </h7><pre class="programlisting"><span class="identifier">ws</span><span class="special">.</span><span class="identifier">handshake</span><span class="special">(</span><span class="string">"localhost"</span><span class="special">,</span> <span class="string">"/"</span><span class="special">);</span>
</pre>
<h7><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.h5"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.handshake.overload1.see_also"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.handshake.overload1.see_also">See
            Also</a>
          </h7><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
                <a href="https://tools.ietf.org/html/rfc6455#section-4.1" target="_top">Websocket
                Opening Handshake Client Requirements (RFC6455)</a>
              </li>
<li class="listitem">
                <a href="https://tools.ietf.org/html/rfc7230#section-5.4" target="_top">Host
                field (RFC7230)</a>
              </li>
<li class="listitem">
                <a href="https://tools.ietf.org/html/rfc7230#section-3.1.1" target="_top">request-target
                (RFC7230)</a>
              </li>
<li class="listitem">
                <a href="https://tools.ietf.org/html/rfc7230#section-5.3.1" target="_top">origin-form
                (RFC7230)</a>
              </li>
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../handshake.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../handshake.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
